Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(v3.6.0) - Poetry migration #448

Merged
merged 25 commits into from
Sep 26, 2024
Merged

(v3.6.0) - Poetry migration #448

merged 25 commits into from
Sep 26, 2024

Conversation

AlejandroCN7
Copy link
Member

@AlejandroCN7 AlejandroCN7 commented Sep 25, 2024

Description

This PR aims to migrate the project's dependency management and packaging to Poetry, as outlined in the referenced issue. The main improvements included in this update, besides Poetry, are described below:

  • Removed unused imports in the project.
  • Coverage: Ignore the gymnasium environment register.
  • Deleted all deprecated files: requirements.txt, MANIFEST.in, setup.py, setup.cfg, conda_environment.yml.
  • Consolidated all previously removed information with Poetry, using both pyproject.toml and poetry.lock.
  • Pytype is operational again, as compatibility with Python 3.12 has been fixed.
  • Improved containers that are clearly differentiated between development (devcontainer) and production or tool usage (in the project root).
  • Added new default extensions for development in VSCode (devcontainer).
  • Installation section has been updated in Sinergym documentation.
  • Add new badge for DockerHub official repository

Regarding Sinergym workflows, there have been some changes:

  • The pytype job has been reintroduced into the automated checks.
  • Poetry is used for the configuration of all jobs.
  • The autopep8 job has been improved. It now causes a failure in the PR to prevent changes in the main branch by a bot, and it is also separated from isort. The functionality to push to the main branch remains for safety.

Motivation and Context

  • I have raised an issue to propose this change (required for new features and bug fixes)

Fixes #435

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Improvement (of an existing feature)
  • Others

Checklist:

  • I've read the CONTRIBUTION guide (required)
  • My change requires a change to the documentation.
  • I have updated the tests.
  • I have updated the documentation accordingly.
  • I have reformatted the code using autopep8 second level aggressive.
  • I have reformatted the code using isort.
  • I have ensured cd docs && make spelling && make html pass (required if documentation has been updated.)
  • I have ensured pytest tests/ -vv pass. (required).
  • I have ensured pytype -d import-error sinergym/ pass. (required)

Changelog:

See Description and commits.

@AlejandroCN7 AlejandroCN7 merged commit ea6673e into main Sep 26, 2024
1 check passed
@AlejandroCN7 AlejandroCN7 deleted the feat/issue-435 branch September 26, 2024 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement]: Migrate package dependency and management to Poetry
1 participant